<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>キャッシュハンドラ関数</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="Smarty マニュアル">
<link rel="up" href="advanced.features.html" title="Chapter 15. 拡張機能">
<link rel="prev" href="advanced.features.outputfilters.html" title="アウトプットフィルタ">
<link rel="next" href="template.resources.html" title="テンプレートリソース">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">キャッシュハンドラ関数</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="advanced.features.outputfilters.html">Prev</a> </td>
<th width="60%" align="center">Chapter 15. 拡張機能</th>
<td width="20%" align="right"> <a accesskey="n" href="template.resources.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="sect1" title="キャッシュハンドラ関数">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="section.template.cache.handler.func"></a>キャッシュハンドラ関数</h2></div></div></div>
<p>
    デフォルトのファイルベースのキャッシュメカニズムの代替として、
    キャッシュファイルの読み書きや破棄を直接行うキャッシュハンドラ関数を指定できます。
   </p>
<p>
    まず、アプリケーション内にSmartyがキャッシュハンドラとして使用するための関数を定義します。
    そしてその関数名を <a class="link" href="variable.cache.handler.func.html" title="$cache_handler_func">
    <em class="parameter"><code>$cache_handler_func</code></em></a>
    クラス変数に指定します。Smarty は、これを使用してキャッシュされたデータを処理します。
    </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>
    第１パラメータはキャッシュの動作を表す文字列で、これは
    <code class="literal">read</code>、<code class="literal">write</code> および
    <code class="literal">clear</code> のいずれかとなります。
    </p></li>
<li class="listitem"><p>
    第２パラメータは Smarty オブジェクトです。
    </p></li>
<li class="listitem"><p>
    第３パラメータはキャッシュの内容です。
    <code class="literal">write</code> の場合はキャッシュされたコンテンツが渡され、
    <code class="literal">read</code> の場合は参照を受け取ってそこにキャッシュされたコンテンツを書き込み、
    <code class="literal">clear</code> の場合はこのパラメータの値を使用しないのでダミーの変数が渡されます。
    </p></li>
<li class="listitem"><p>
    第４パラメータはテンプレートファイル名です('read'又は'write'の場合に必要)。
    </p></li>
<li class="listitem"><p>
    任意の第５パラメータは <em class="parameter"><code>$cache_id</code></em> です。
    </p></li>
<li class="listitem"><p>
    任意の第６パラメータは <a class="link" href="variable.compile.id.html" title="$compile_id">
    <em class="parameter"><code>$compile_id</code></em></a> です。
    </p></li>
<li class="listitem"><p>
    最後の第７パラメータ <em class="parameter"><code>$exp_time</code></em>
    は Smarty-2.6.0 で追加されました。
   </p></li>
</ul></div>
<div class="example">
<a name="id2856626"></a><p class="title"><b>Example 15.5. キャッシュソースとしてMySQLを使用する例</b></p>
<div class="example-contents"><pre class="programlisting">

&lt;?php
/**************************************************
example usage:

include('Smarty.class.php');
include('mysql_cache_handler.php');

$smarty = new Smarty;
$smarty-&gt;cache_handler_func = 'mysql_cache_handler';

$smarty-&gt;display('index.tpl');


MySQLデータベースのスキーマ定義

create database SMARTY_CACHE;

create table CACHE_PAGES(
CacheID char(32) PRIMARY KEY,
CacheContents MEDIUMTEXT NOT NULL
);

**************************************************/

function mysql_cache_handler($action, &amp;$smarty_obj, &amp;$cache_content, $tpl_file=null, $cache_id=null, $compile_id=null, $exp_time=null)
{
	// ここでDBのホスト名・ユーザ名・パスワードを指定します
	$db_host = 'localhost';
	$db_user = 'myuser';
	$db_pass = 'mypass';
	$db_name = 'SMARTY_CACHE';
	$use_gzip = false;

	// ユニークなキャッシュIDを作成します
	$CacheID = md5($tpl_file.$cache_id.$compile_id);

	if(! $link = mysql_pconnect($db_host, $db_user, $db_pass)) {
		$smarty_obj-&gt;_trigger_error_msg('cache_handler: could not connect to database');
		return false;
	}
	mysql_select_db($db_name);

	switch ($action) {
		case 'read':
			// キャッシュをデータベースから読み込みます
			$results = mysql_query("select CacheContents from CACHE_PAGES where CacheID='$CacheID'");
			if(!$results) {
				$smarty_obj-&gt;_trigger_error_msg('cache_handler: query failed.');
			}
			$row = mysql_fetch_array($results,MYSQL_ASSOC);

			if($use_gzip &amp;&amp; function_exists('gzuncompress')) {
				$cache_content = gzuncompress($row['CacheContents']);
			} else {
				$cache_content = $row['CacheContents'];
			}
			$return = $results;
			break;
		case 'write':
			// キャッシュをデータベースに保存します

			if($use_gzip &amp;&amp; function_exists("gzcompress")) {
				// 記憶効率のために内容を圧縮します
				$contents = gzcompress($cache_content);
			} else {
				$contents = $cache_content;
			}
			$results = mysql_query("replace into CACHE_PAGES values(
							'$CacheID',
							'".addslashes($contents)."')
						");
			if(!$results) {
				$smarty_obj-&gt;_trigger_error_msg('cache_handler: query failed.');
			}
			$return = $results;
			break;
		case 'clear':
			// キャッシュ情報を破棄します
			if(empty($cache_id) &amp;&amp; empty($compile_id) &amp;&amp; empty($tpl_file)) {
				// 全てのキャッシュを破棄します
				$results = mysql_query('delete from CACHE_PAGES');
			} else {
				$results = mysql_query("delete from CACHE_PAGES where CacheID='$CacheID'");
			}
			if(!$results) {
				$smarty_obj-&gt;_trigger_error_msg('cache_handler: query failed.');
			}
			$return = $results;
			break;
		default:
			// エラー・未知の動作
			$smarty_obj-&gt;_trigger_error_msg("cache_handler: unknown action \"$action\"");
			$return = false;
			break;
	}
	mysql_close($link);
	return $return;

}

?&gt;

</pre></div>
</div>
<br class="example-break">
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="advanced.features.outputfilters.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href="advanced.features.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="template.resources.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">アウトプットフィルタ </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top"> テンプレートリソース</td>
</tr>
</table>
</div>
</body>
</html>
